Reset emoji suggestion pop-up automatically after an emoji has been inserted #27711

ahmedGaber93 · 2023-09-18T20:46:20Z

Details

Fixed Issues

$ #27156
PROPOSAL: #27156 (comment)

Tests

Open the app and go to any chat.
Type in ':eye' and colon ':' in the end to insert 👁️ emoji.
Verify that emoji suggestion is closed automatically after you typed last colon ':' and emoji 👁️ is inserted.

Verify that no errors appear in the JS console

Offline tests

N/A.

QA Steps

Same as Tests step.

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-09-18.at.9.18.58.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-09-18.at.9.50.20.PM.mov

Mobile Web - Safari

Screen.Recording.2023-09-18.at.8.31.27.PM.mov

Desktop

Screen.Recording.2023-09-18.at.10.42.29.PM.mov

iOS

Screen.Recording.2023-09-18.at.8.29.11.PM.mov

Android

Screen.Recording.2023-09-18.at.10.15.58.PM.mov

melvin-bot · 2023-09-18T20:46:26Z

@jjcoffee Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

jjcoffee · 2023-09-19T12:00:01Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

chrome-desktop-2023-09-19_14.32.24.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari-2023-09-19_14.48.44.mp4

Desktop

mac-desktop-2023-09-19_14.45.23.mp4

iOS

ios-native-2023-09-19_15.40.26.mp4

Android

android-native.mp4

jjcoffee · 2023-09-19T12:27:21Z

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions.js

+                // Reset emoji suggestions when an emoji is replaced.
+                // Important when emoji is replaced and the selection is not changed, more info issue #27156


Suggested change

// Reset emoji suggestions when an emoji is replaced.

// Important when emoji is replaced and the selection is not changed, more info issue #27156

// Ensure emoji suggestions are hidden even when the selection is not changed (so calculateEmojiSuggestion would not be called).

I think we can make this comment a bit more concise.

jjcoffee · 2023-09-19T12:31:02Z

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions.js

@@ -185,6 +185,12 @@ function ComposerWithSuggestions({
            setIsCommentEmpty(!!newComment.match(/^(\s)*$/));
            setValue(newComment);
            if (commentValue !== newComment) {
+                // Reset emoji suggestions when an emoji is replaced.
+                // Important when emoji is replaced and the selection is not changed, more info issue #27156
+                if (suggestionsRef.current) {


I wonder if we should also have !_.isEmpty(emojis) as a condition here? I guess it's possible that in future newComment might not only be changed by emoji replacements, so might be worth future-proofing.

I guess it's possible that in future newComment might not only be changed by emoji replacements

@jjcoffee
I agree about that, but I think !_.isEmpty(emojis) will not be useful in this case because emojis it returns all emoji in the text not only the current replaced emojis.
For example: text with emoji 😄👁️ then many lines of text then cursor at the end writing normal letters not emoji will return emojis = [😄, 👁️]

newComment now in the code refer to comment after replace emoji.
So I think If new replacement applied in the future, in this time the fix should be if (commentValueWithEmoji !== commentValueWithoutEmoji)

@ahmedGaber93 Ah yes I see what you mean, that makes sense. Let's leave it for now then!

jjcoffee

LGTM!

MariaHCD · 2023-09-20T03:53:08Z

@ahmedGaber93 can you update the PR title to reflect the code changes in this PR?

ahmedGaber93 · 2023-09-20T07:20:26Z

@MariaHCD Updated.

MariaHCD · 2023-09-20T08:05:00Z

@ahmedGaber93 I think your PR title should describe what the PR is doing instead of describing what it fixes. I updated the title, let me know if you think it should be different!

OSBotify · 2023-09-20T09:02:06Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.3.72-1 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-09-22T13:25:04Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.72-11 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-09-25T10:09:30Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.3.74-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-09-28T18:51:51Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

ahmedGaber93 added 2 commits September 18, 2023 22:29

fix issue 27156

baa788a

fix issue 27156

124ec28

ahmedGaber93 requested a review from a team as a code owner September 18, 2023 20:46

melvin-bot bot requested review from jjcoffee and removed request for a team September 18, 2023 20:46

ahmedGaber93 mentioned this pull request Sep 18, 2023

[HOLD for payment 2023-09-29] [$500] Chat - Emoji suggestion does not auto close after inserting eye emoji #27156

Closed

6 tasks

ahmedGaber93 added 2 commits September 18, 2023 23:04

lint and remove selection compare

a66f27c

prettier

ff989cc

jjcoffee reviewed Sep 19, 2023

View reviewed changes

improve comments

aa5f44f

jjcoffee approved these changes Sep 19, 2023

View reviewed changes

melvin-bot bot requested a review from MariaHCD September 19, 2023 15:00

MariaHCD approved these changes Sep 20, 2023

View reviewed changes

ahmedGaber93 changed the title ~~Issue 27156~~ fix app does not close emoji suggestion automatically after type some emoji Sep 20, 2023

MariaHCD changed the title ~~fix app does not close emoji suggestion automatically after type some emoji~~ Reset emoji suggestion pop-up automatically after an emoji has been inserted Sep 20, 2023

MariaHCD merged commit 82acaf3 into Expensify:main Sep 20, 2023

OSBotify mentioned this pull request Sep 20, 2023

Deploy Checklist: New Expensify 2023-09-20 #27837

Closed

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

aimane-chnaif mentioned this pull request Sep 27, 2023

[HOLD for payment 2023-10-25] [$1000] Chat - Emoji suggestion list does not disappear when typing 👍 in the composer #20998

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reset emoji suggestion pop-up automatically after an emoji has been inserted #27711

Reset emoji suggestion pop-up automatically after an emoji has been inserted #27711

ahmedGaber93 commented Sep 18, 2023

melvin-bot bot commented Sep 18, 2023

jjcoffee commented Sep 19, 2023 •

edited

Loading

jjcoffee Sep 19, 2023

ahmedGaber93 Sep 19, 2023

jjcoffee Sep 19, 2023

ahmedGaber93 Sep 19, 2023

jjcoffee Sep 19, 2023

jjcoffee left a comment

MariaHCD commented Sep 20, 2023

ahmedGaber93 commented Sep 20, 2023

MariaHCD commented Sep 20, 2023

OSBotify commented Sep 20, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

		// Reset emoji suggestions when an emoji is replaced.
		// Important when emoji is replaced and the selection is not changed, more info issue #27156

	// Reset emoji suggestions when an emoji is replaced.
	// Important when emoji is replaced and the selection is not changed, more info issue #27156
	// Ensure emoji suggestions are hidden even when the selection is not changed (so calculateEmojiSuggestion would not be called).

Reset emoji suggestion pop-up automatically after an emoji has been inserted #27711

Reset emoji suggestion pop-up automatically after an emoji has been inserted #27711

Conversation

ahmedGaber93 commented Sep 18, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 18, 2023

jjcoffee commented Sep 19, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee Sep 19, 2023

Choose a reason for hiding this comment

ahmedGaber93 Sep 19, 2023

Choose a reason for hiding this comment

jjcoffee Sep 19, 2023

Choose a reason for hiding this comment

ahmedGaber93 Sep 19, 2023

Choose a reason for hiding this comment

jjcoffee Sep 19, 2023

Choose a reason for hiding this comment

jjcoffee left a comment

Choose a reason for hiding this comment

MariaHCD commented Sep 20, 2023

ahmedGaber93 commented Sep 20, 2023

MariaHCD commented Sep 20, 2023

OSBotify commented Sep 20, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

jjcoffee commented Sep 19, 2023 •

edited

Loading